Filter hook 'add_{$meta_type}_metadata'

in WP Core File wp-includes/meta.php at line 86

View Source

add_{$meta_type}_metadata

Filter Hook
Description
Short-circuits adding metadata of a specific type. The dynamic portion of the hook name, `$meta_type`, refers to the meta object type (post, comment, term, user, or any other type with an associated meta table). Returning a non-null value will effectively short-circuit the function. Possible hook names include: - `add_post_metadata` - `add_comment_metadata` - `add_term_metadata` - `add_user_metadata`

Hook Information

File Location wp-includes/meta.php View on GitHub
Hook Type Filter
Line Number 86

Hook Parameters

Type Name Description
null|bool $check Whether to allow adding metadata for the given type.
int $object_id ID of the object metadata is for.
string $meta_key Metadata key.
mixed $meta_value Metadata value. Must be serializable if non-scalar.
bool $unique Whether the specified meta key should be unique for the object.

Usage Examples

Basic Usage
<?php
// Hook into add_{$meta_type}_metadata
add_filter('add_{$meta_type}_metadata', 'my_custom_filter', 10, 5);

function my_custom_filter($check, $object_id, $meta_key, $meta_value, $unique) {
    // Your custom filtering logic here
    return $check;
}

Source Code Context

wp-includes/meta.php:86 - How this hook is used in WordPress core
<?php
  81  	 * @param int       $object_id  ID of the object metadata is for.
  82  	 * @param string    $meta_key   Metadata key.
  83  	 * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.
  84  	 * @param bool      $unique     Whether the specified meta key should be unique for the object.
  85  	 */
  86  	$check = apply_filters( "add_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $unique );
  87  	if ( null !== $check ) {
  88  		return $check;
  89  	}
  90  
  91  	if ( $unique && $wpdb->get_var(

PHP Documentation

<?php
/**
	 * Short-circuits adding metadata of a specific type.
	 *
	 * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
	 * (post, comment, term, user, or any other type with an associated meta table).
	 * Returning a non-null value will effectively short-circuit the function.
	 *
	 * Possible hook names include:
	 *
	 *  - `add_post_metadata`
	 *  - `add_comment_metadata`
	 *  - `add_term_metadata`
	 *  - `add_user_metadata`
	 *
	 * @since 3.1.0
	 *
	 * @param null|bool $check      Whether to allow adding metadata for the given type.
	 * @param int       $object_id  ID of the object metadata is for.
	 * @param string    $meta_key   Metadata key.
	 * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.
	 * @param bool      $unique     Whether the specified meta key should be unique for the object.
	 */
Quick Info
  • Hook Type: Filter
  • Parameters: 5
  • File: wp-includes/meta.php
Related Hooks

Related hooks will be displayed here in future updates.